CreateRectangularGradientFill(Double,Double,Double,Double,CellFillGradientStop[]) Method

Creates a rectangular gradient that can be applied to a cell's fill.

Syntax

Visual Basic

'Declaration
 
Public Overloads Shared Function CreateRectangularGradientFill( _
   ByVal left As Double, _
   ByVal top As Double, _
   ByVal right As Double, _
   ByVal bottom As Double, _
   ByVal ParamArray stops() As CellFillGradientStop _
) As CellFillRectangularGradient

C#

public static CellFillRectangularGradient CreateRectangularGradientFill( 
   double left,
   double top,
   double right,
   double bottom,
   params CellFillGradientStop[] stops
)

Parameters

left

The left edge of the inner rectangle of the gradient, ranging from 0.0 (the left of the cell) to 1.0 (the right of the cell).

top

The top edge of the inner rectangle of the gradient, ranging from 0.0 (the top of the cell) to 1.0 (the bottom of the cell).

right

The right edge of the inner rectangle of the gradient, ranging from 0.0 (the left of the cell) to 1.0 (the right of the cell).

bottom

The bottom edge of the inner rectangle of the gradient, ranging from 0.0 (the top of the cell) to 1.0 (the bottom of the cell).

stops

Two or more gradient stops which describe the color transitions and their positions within the gradient.

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	left, top, right, or bottom are less than 0.0 or greater than 1.0.
System.ArgumentException	stops contains less than two gradient stops. There must be at least two stops to define the gradient.

Remarks

The rectangular gradient is defined by specifying an inner rectangle and a set of gradient stops. The gradient goes from the edges of the inner rectangle to the edges of the cell. If the inner rectangle does not have a height or width of 0, the color of the first gradient stop will be filled in the center of the inner rectangle.

The inner rectangle is defined by the left, top, right, and bottom parameters. They are relative values ranging from 0.0 to 1.0 and they go from the top/left to the bottom/right. So, for example, to specify a gradient that goes out from the center, all values would be 0.5. Or to specify a gradient which goes out from the bottom-left corner of the cell, the following values would be used: left = 0.0, top = 1.0, right = 0.0, bottom = 1.0.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2